home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3dm / fx / dmPMProcessClip.z / dmPMProcessClip
Encoding:
Text File  |  1998-10-20  |  15.5 KB  |  265 lines
  1.  
  2.  
  3.  
  4. ddddmmmmPPPPMMMMPPPPrrrroooocccceeeessssssssIIIImmmmaaaaggggeeeeCCCClllliiiipppp((((3333ddddmmmm))))                            ddddmmmmPPPPMMMMPPPPrrrroooocccceeeessssssssIIIImmmmaaaaggggeeeeCCCClllliiiipppp((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ddddmmmmPPPPMMMMPPPPrrrroooocccceeeessssssssIIIImmmmaaaaggggeeeeCCCClllliiiipppp, ddddmmmmPPPPMMMMPPPPrrrroooocccceeeessssssssIIIImmmmaaaaggggeeeeCCCClllliiiippppWWWWiiiitttthhhhPPPPrrrrooooggggrrrreeeessssssss - apply special
  10.      effects to movies
  11.  
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////ffffxxxx____pppplllluuuuggggiiiinnnn____mmmmggggrrrr....hhhh>>>>
  15.  
  16.      ttttyyyyppppeeeeddddeeeeffff ssssttttrrrruuuucccctttt ________DDDDMMMMpppprrrroooocccceeeessssssssoooopppp
  17.      {{{{
  18.          DDDDMMMMooooppppttttyyyyppppeeee   ttttyyyyppppeeee;;;;
  19.          MMMMVVVViiiidddd       mmmmoooovvvviiiieeee;;;;
  20.          MMMMVVVViiiidddd       ttttrrrraaaacccckkkk;;;;
  21.          MMMMVVVVttttiiiimmmmeeee     ssssttttaaaarrrrttttTTTTiiiimmmmeeee;;;;
  22.          DDDDMMMMeeeeffffffffeeeecccctttt****  eeeeffffffffeeeecccctttt;;;;
  23.          iiiinnnntttt        ttttoooottttaaaallllFFFFrrrraaaammmmeeeessss;;;;
  24.          iiiinnnntttt        ssssttttaaaarrrrttttFFFFrrrraaaammmmeeee;;;;
  25.      }}}} DDDDMMMMpppprrrroooocccceeeessssssssoooopppp;;;;
  26.  
  27.      ttttyyyyppppeeeeddddeeeeffff DDDDMMMMbbbboooooooolllleeeeaaaannnn ((((DDDDMMMMpppprrrrooooggggrrrreeeessssssssccccaaaallllllllbbbbaaaacccckkkk))))
  28.            (((( ffffllllooooaaaatttt ffffrrrraaaaccccttttiiiioooonnnnCCCCoooommmmpppplllleeeetttteeee,,,,
  29.              vvvvooooiiiidddd**** cccclllliiiieeeennnnttttDDDDaaaattttaaaa ))));;;;
  30.  
  31.      DDDDMMMMpppplllluuuuggggiiiinnnn**** ddddmmmmPPPPMMMMPPPPrrrroooocccceeeessssssssIIIImmmmaaaaggggeeeeCCCClllliiiipppp
  32.            (((( DDDDMMMMpppprrrroooocccceeeessssssssoooopppp**** aaaarrrrrrrraaaayyyyOOOOffffooooppppeeeerrrraaaattttiiiioooonnnnssss,,,,
  33.              iiiinnnntttt nnnnuuuummmmbbbbeeeerrrrOOOOffffOOOOppppeeeerrrraaaattttiiiioooonnnnssss,,,,
  34.              DDDDMMMMbbbboooooooolllleeeeaaaannnn ccccaaaallllllllSSSSeeeettttuuuupppp,,,,
  35.              MMMMVVVVttttiiiimmmmeeeessssccccaaaalllleeee ttttiiiimmmmeeeessssccccaaaalllleeee,,,,
  36.              MMMMVVVVttttiiiimmmmeeee ffffrrrraaaammmmeeeeDDDDuuuurrrraaaattttiiiioooonnnn,,,,
  37.              MMMMVVVVttttiiiimmmmeeee mmmmoooovvvviiiieeeeDDDDuuuurrrraaaattttiiiioooonnnn,,,,
  38.              MMMMVVVViiiidddd ddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnTTTTrrrraaaacccckkkk,,,,
  39.              MMMMVVVVttttiiiimmmmeeee ddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnSSSSttttaaaarrrrttttTTTTiiiimmmmeeee ))))
  40.  
  41.      DDDDMMMMpppplllluuuuggggiiiinnnn**** ddddmmmmPPPPMMMMPPPPrrrroooocccceeeessssssssIIIImmmmaaaaggggeeeeCCCClllliiiippppWWWWiiiitttthhhhPPPPrrrrooooggggrrrreeeessssssss
  42.            (((( DDDDMMMMpppprrrroooocccceeeessssssssoooopppp**** aaaarrrrrrrraaaayyyyOOOOffffooooppppeeeerrrraaaattttiiiioooonnnnssss,,,,
  43.              iiiinnnntttt nnnnuuuummmmbbbbeeeerrrrOOOOffffOOOOppppeeeerrrraaaattttiiiioooonnnnssss,,,,
  44.              DDDDMMMMbbbboooooooolllleeeeaaaannnn ccccaaaallllllllSSSSeeeettttuuuupppp,,,,
  45.              MMMMVVVVttttiiiimmmmeeeessssccccaaaalllleeee ttttiiiimmmmeeeessssccccaaaalllleeee,,,,
  46.              MMMMVVVVttttiiiimmmmeeee ffffrrrraaaammmmeeeeDDDDuuuurrrraaaattttiiiioooonnnn,,,,
  47.              MMMMVVVVttttiiiimmmmeeee mmmmoooovvvviiiieeeeDDDDuuuurrrraaaattttiiiioooonnnn,,,,
  48.              MMMMVVVViiiidddd ddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnTTTTrrrraaaacccckkkk,,,,
  49.              MMMMVVVVttttiiiimmmmeeee ddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnSSSSttttaaaarrrrttttTTTTiiiimmmmeeee,,,,
  50.              DDDDMMMMpppprrrrooooggggrrrreeeessssssssccccaaaallllllllbbbbaaaacccckkkk**** pppprrrrooooggggrrrreeeessssssssCCCCaaaallllllllbbbbaaaacccckkkk,,,,
  51.              vvvvooooiiiidddd**** pppprrrrooooggggrrrreeeessssssssCCCClllliiiieeeennnnttttDDDDaaaattttaaaa ))))
  52.  
  53.  
  54. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  55.      _a_r_r_a_y_O_f_O_p_e_r_a_t_i_o_n_s      an array of: source movies, filters, and
  56.                             transitions
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ddddmmmmPPPPMMMMPPPPrrrroooocccceeeessssssssIIIImmmmaaaaggggeeeeCCCClllliiiipppp((((3333ddddmmmm))))                            ddddmmmmPPPPMMMMPPPPrrrroooocccceeeessssssssIIIImmmmaaaaggggeeeeCCCClllliiiipppp((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74.      _n_u_m_b_e_r_O_f_O_p_e_r_a_t_i_o_n_s     The number of DMprocessops in _a_r_r_a_y_O_f_O_p_e_r_a_t_i_o_n_s.
  75.  
  76.  
  77.      _c_a_l_l_S_e_t_u_p              If true, the setup function (ddddmmmmPPPPMMMMSSSSeeeettttuuuuppppVVVViiiiddddeeeeooooFFFFiiiilllltttteeeerrrr
  78.                             or ddddmmmmPPPPMMMMSSSSeeeettttuuuuppppVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn) will be called once
  79.                             for each effect before the movie is processed.
  80.  
  81.  
  82.      _f_r_a_m_e_D_u_r_a_t_i_o_n          The fraction _f_r_a_m_e_D_u_r_a_t_i_o_n/_t_i_m_e_s_c_a_l_e is the
  83.                             duration, in seconds, of each frame generated.
  84.  
  85.  
  86.      _m_o_v_i_e_D_u_r_a_t_i_o_n          The fraction _m_o_v_i_e_D_u_r_a_t_i_o_n/_t_i_m_e_s_c_a_l_e is the
  87.                             duration, in seconds, of the movie to be
  88.                             processed.
  89.  
  90.  
  91.      _d_e_s_t_i_n_a_t_i_o_n_T_r_a_c_k       A movie track into which the processed frames are
  92.                             inserted.
  93.  
  94.  
  95.      _d_e_s_t_i_n_a_t_i_o_n_S_t_a_r_t_T_i_m_e   The location (time) in _d_e_s_t_i_n_a_t_i_o_n_T_r_a_c_k where the
  96.                             processed images will be inserted.
  97.  
  98.  
  99.      _p_r_o_g_r_e_s_s_C_a_l_l_b_a_c_k       A function that will be called after each step in
  100.                             the processing.
  101.  
  102.  
  103.      _t_i_m_e_s_c_a_l_e              Client data for _p_r_o_g_r_e_s_s_C_a_l_l_b_a_c_k.
  104.  
  105.  
  106. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  107.      ddddmmmmPPPPMMMMPPPPrrrroooocccceeeessssssssIIIImmmmaaaaggggeeeeCCCClllliiiipppp applies video filters and transitions to movies,
  108.      producing a new movie as the result.  For example, a blur filter could be
  109.      applied to an entire movie to produce a new movie with blurred images.
  110.  
  111.  
  112.      The input to ddddmmmmPPPPMMMMPPPPrrrroooocccceeeessssssssIIIImmmmaaaaggggeeee is a sequence of operations to be performed
  113.      for each frame in the generated movie.  During the processing of each
  114.      frame, a stack of images is maintained.  The operations add new images to
  115.      the stack, replace the top-of-stack with a filtered image, or replace the
  116.      top two images with a transition between them.
  117.  
  118.  
  119.      The output is a sequence of images of duration _m_o_v_i_e_D_u_r_a_t_i_o_n.  Each frame
  120.      in the sequence has a duration of _f_r_a_m_e_D_u_r_a_t_i_o_n.  Thus, the number of
  121.      frames produced is:  _m_o_v_i_e_D_u_r_a_t_i_o_n/_f_r_a_m_e_D_u_r_a_t_i_o_n.  If the given
  122.      _m_o_v_i_e_D_u_r_a_t_i_o_n is not an event multiple of the _f_r_a_m_e_D_u_r_a_t_i_o_n, the last
  123.      frame will extend past _m_o_v_i_e_D_u_r_a_t_i_o_n; in other words, the _m_o_v_i_e_D_u_r_a_t_i_o_n
  124.      is rounded up to a multiple of _f_r_a_m_e_D_u_r_a_t_i_o_n. This sequence of frames is
  125.      inserted into _d_e_s_t_i_n_a_t_i_o_n_T_r_a_c_k starting at time _d_e_s_t_i_n_a_t_i_o_n_S_t_a_r_t_T_i_m_e.
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ddddmmmmPPPPMMMMPPPPrrrroooocccceeeessssssssIIIImmmmaaaaggggeeeeCCCClllliiiipppp((((3333ddddmmmm))))                            ddddmmmmPPPPMMMMPPPPrrrroooocccceeeessssssssIIIImmmmaaaaggggeeeeCCCClllliiiipppp((((3333ddddmmmm))))
  137.  
  138.  
  139.  
  140.      _a_r_r_a_y_O_f_O_p_e_r_a_t_i_o_n_s points to an array of _D_M_p_r_o_c_e_s_s_o_ps.  The _t_y_p_e field can
  141.      be one of: DDDDMMMM____MMMMOOOOVVVVIIIIEEEE, DDDDMMMM____TTTTRRRRAAAACCCCKKKK, DDDDMMMM____FFFFIIIILLLLTTTTEEEERRRR, or DDDDMMMM____TTTTRRRRAAAANNNNSSSSIIIITTTTIIIIOOOONNNN.
  142.  
  143.  
  144.      The DDDDMMMM____MMMMOOOOVVVVIIIIEEEE operation take a frame from a source movie and pushes it on
  145.      the stack.  The first frame used is the one at time _s_t_a_r_t_T_i_m_e.  The
  146.      second frame used is the one at time _s_t_a_r_t_T_i_m_e+_f_r_a_m_e_D_u_r_a_t_i_o_n, etc.
  147.  
  148.  
  149.      The DDDDMMMM____TTTTRRRRAAAACCCCKKKK operation take a frame from one track of a movie and pushes
  150.      it on the stack.  The first frame used is the one at time _s_t_a_r_t_T_i_m_e.  The
  151.      second frame used is the one at time _s_t_a_r_t_T_i_m_e+_f_r_a_m_e_D_u_r_a_t_i_o_n, etc.
  152.  
  153.  
  154.      The DDDDMMMM____FFFFIIIILLLLTTTTEEEERRRR operation applies a video filter to the top image on the
  155.      stack, replacing it with the filtered image.  If _c_a_l_l_S_e_t_u_p is true, an
  156.      interactive dialog will pop up to get custom settings for the filter.
  157.  
  158.  
  159.      Some filters animate over time.  _s_t_a_r_t_F_r_a_m_e and _t_o_t_a_l_F_r_a_m_e_s allow control
  160.      over which part of the animation is used.  For example, using a filter
  161.      that starts with the original image and fades to black over time, a
  162.      setting _s_t_a_r_t_F_r_a_m_e to a value other than 0 can render the first output
  163.      frame partially faded.
  164.  
  165.  
  166.      As an example, say you are rendering a clip with 10 frames, and you want
  167.      to start with the first frame 50% faded, and end with the last frame 75%
  168.      faded.  The number of frames needed to do a full fade at this rate from
  169.      0% to 100% is 40, so _t_o_t_a_l_F_r_a_m_e_s should be set to 40.  To start at 50% of
  170.      a 40-frame fade, _s_t_a_r_t_F_r_a_m_e should be set to 20.
  171.  
  172.  
  173.      The number of frames rendered to the output movie must not be greater
  174.      than (_t_o_t_a_l_F_r_a_m_e_s - _s_t_a_r_t_F_r_a_m_e).
  175.  
  176.  
  177.      The DDDDMMMM____TTTTRRRRAAAANNNNSSSSIIIITTTTIIIIOOOONNNN operation applies a video filter to the top two images
  178.      on the stack, replacing them with the filtered image.  If _c_a_l_l_S_e_t_u_p is
  179.      true, an interactive dialog will pop up to get custom settings for the
  180.      filter.  Animation can be controlled with _s_t_a_r_t_F_r_a_m_e and _t_o_t_a_l_F_r_a_m_e_s, as
  181.      with filters (see above).
  182.  
  183.  
  184.      ddddmmmmPPPPMMMMPPPPrrrroooocccceeeessssssssCCCClllliiiippppWWWWiiiitttthhhhPPPPrrrrooooggggrrrreeeessssssss does exactly the same thing.  In addition, it
  185.      periodically calls _p_r_o_g_r_e_s_s_C_a_l_l_b_a_c_k during the processing.  The value
  186.      returned by _p_r_o_g_r_e_s_s_C_a_l_l_b_a_c_k indicates whether or not to continue the
  187.      processing.  DDDDMMMM____TTTTRRRRUUUUEEEE means to continue, DDDDMMMM____FFFFAAAALLLLSSSSEEEE means to stop.
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. ddddmmmmPPPPMMMMPPPPrrrroooocccceeeessssssssIIIImmmmaaaaggggeeeeCCCClllliiiipppp((((3333ddddmmmm))))                            ddddmmmmPPPPMMMMPPPPrrrroooocccceeeessssssssIIIImmmmaaaaggggeeeeCCCClllliiiipppp((((3333ddddmmmm))))
  203.  
  204.  
  205.  
  206. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEESSSS
  207.      DDDDMMMM____SSSSUUUUCCCCCCCCEEEESSSSSSSS is returned if the processing of all frames was completed.
  208.      DDDDMMMM____FFFFAAAAIIIILLLLUUUURRRREEEE is returned otherwise; an error code can be obtained from
  209.      ddddmmmmGGGGeeeettttEEEErrrrrrrroooorrrr.
  210.  
  211.  
  212. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  213.      dmPMCreateEffect(3dm), mvIntro(3dm), dmGetError(3dm).
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.